/**
 * Copyright (c) 2008, Andrew Carter
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without modification, are 
 * permitted provided that the following conditions are met:
 * 
 * Redistributions of source code must retain the above copyright notice, this list of 
 * conditions and the following disclaimer. Redistributions in binary form must reproduce 
 * the above copyright notice, this list of conditions and the following disclaimer in 
 * the documentation and/or other materials provided with the distribution. Neither the 
 * name of Andrew Carter nor the names of contributors may be used to endorse or promote 
 * products derived from this software without specific prior written permission. 
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
 * SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR 
 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.acarter.scenemonitor.textdescriptor.definitions;

import java.util.logging.Logger;

import javax.swing.text.BadLocationException;
import javax.swing.text.StyledDocument;

import com.acarter.scenemonitor.textdescriptor.A_TextDescriptor;
import com.jme.scene.Controller;

/**
 * @author Carter
 * 
 */
public class ControllerDescriptor extends A_TextDescriptor {

	/**  */
	public static final String LOGGER_NAME = "com.acarter.scenemonitor.textdescriptor.definitions.ControllerDescriptor";

	/**  */
	private static final Logger LOGGER = Logger.getLogger(ControllerDescriptor.LOGGER_NAME);

	/*
	 * (non-Javadoc)
	 * 
	 * @see com.acarter.scenemonitor.descriptor.A_MonitorDescriptor#UpdateInfo(javax.swing.text.StyledDocument,
	 *      java.lang.Object)
	 */
	@Override
	public void updateInfo(StyledDocument infoDocument, Object object) {

		if ((object != null) && (object instanceof Controller)) {

			Controller controller = (Controller) object;

			try {
				clearDocument(infoDocument);
				writeString(infoDocument, controller.getClass().getSimpleName() + "\n", "bold");
				writeString(infoDocument, "Controller\n\n", "small");
				
				writeString(infoDocument, "Active: ", "bold");
				writeString(infoDocument, controller.isActive() + "\n\n", "regular");

				writeString(infoDocument, "Repeat Type: ", "bold");
				writeString(infoDocument, E_RepeatType.getConstant(controller.getRepeatType()) + "\n", "regular");
				writeString(infoDocument, "Speed: ", "bold");
				writeString(infoDocument, Float.toString(controller.getSpeed()) + "\n", "regular");
				writeString(infoDocument, "Min Time: ", "bold");
				writeString(infoDocument, Float.toString(controller.getMinTime()) + "\n", "regular");
				writeString(infoDocument, "Max Time: ", "bold");
				writeString(infoDocument, Float.toString(controller.getMaxTime()), "regular");
				
				
			} catch (BadLocationException ble) {
				LOGGER.warning("Could not insert info text.");
			}

		}
	}

	/**
	 * Enumerates the permissible controller repeat types.
	 * 
	 * @author Andrew Carter
	 */
	protected enum E_RepeatType {

		CLAMP("Clamp", 0),

		WRAP("Wrap", 1),

		CYCLE("Cycle", 2);

		/** String representation of the enum value */
		private String name;

		/** Integer value of the enum value */
		private int value;

		/**
		 * Private constructor.
		 * 
		 * @param value
		 *            String literal of the enum
		 */
		private E_RepeatType(String name, int value) {

			this.name = name;
			this.value = value;
		}

		/**
		 * Returns the enum constant matching the name string.
		 * 
		 * @param name
		 *            string value of enum constant
		 * @return matching enum constant or null
		 */
		public static E_RepeatType getConstant(String name) {

			for (E_RepeatType constant : E_RepeatType.values()) {

				if (constant.toString().compareToIgnoreCase(name) == 0)
					return constant;
			}

			return null;
		}

		/**
		 * Returns the enum constant matching the type value.
		 * 
		 * @param type
		 *            type value of enum constant
		 * @return matching enum constant or null
		 */
		public static E_RepeatType getConstant(int type) {

			for (E_RepeatType constant : E_RepeatType.values()) {

				if (constant.getType() == type)
					return constant;
			}

			return CLAMP;
		}

		/**
		 * Returns the string value of the constant.
		 */
		public String toString() {

			return name;
		}

		/**
		 * Returns the integer value of the constant.
		 * 
		 * @return
		 */
		public int getType() {

			return value;
		}
	}

}
